ApiObject
Introduction
Every event function receives the yeet API object as its first argument.
This object contains all functions and constructors you need to interact with yeet elements.
UI
The following functions are available in the UI group:
getObject()
getObject(id, type, sourceConfigType?, sourceConfigId?) => yeetRuntimeObject
Create a new RuntimeObject by specifying the unique ID and the component type. If a component is supposed to be used outside of the active main container, you must also specify the ID and component type of the main container.
| Name | Type | Description |
|---|---|---|
| id | number | Component ID general > meta > componentId |
| type | string | Component type general > meta > componentType |
| sourceConfigType (optional) | string | Main container type general > meta > componentType |
| sourceConfigId (optional) | id | Main container ID general > meta > componentId |
As a return value, you receive the matching yeetRuntimeObject.
instanceid
Returns the current instanceId of a component inside a yTemplateList.
The default value is -1.
Types
Constructors for creating complex property values.
colorValue
Creates a color value from a hex string.
transparent#FFF#FFFFFF#FF00FFFF
All input values are stored in the hex8 property as #RRGGBBAA (hex8 color).
class ColorValue {
hex8 : string
constructor(hexString)
}
columnValue
To create a custom table column.
class columnValue {
field: StringProperty;
type: StringProperty;
nullable: BooleanProperty;
displayEditDialog: StringProperty;
displayTable: StringProperty;
sort: StringProperty;
filter: BooleanProperty;
label: StringProperty;
name: StringProperty;
visible: BooleanProperty;
sticky: BooleanProperty;
orderId: NumberProperty;
userCreated: BooleanProperty;
bodyCell__minWidth: UnitNumberProperty | undefined;
bodyCell__maxWidth: UnitNumberProperty | undefined;
bodyCell__fontAlignHorizontal: StringProperty | undefined;
bodyCell__fontAlignVertical: StringProperty | undefined;
bodyCell__bgColor: ColorProperty | undefined;
bodyCell__fontSize: UnitNumberProperty | undefined;
bodyCell__fontWeight: NumberProperty | undefined;
bodyCell__fontColor: ColorProperty | undefined;
columnHeader__fontAlignHorizontal: StringProperty | undefined;
columnHeader__fontAlignVertical: StringProperty | undefined;
columnHeader__bgColor: ColorProperty | undefined;
columnHeader__fontSize: UnitNumberProperty | undefined;
columnHeader__fontWeight: NumberProperty | undefined;
columnHeader__fontColor: ColorProperty | undefined;
constructor(
field = "NoField"
type = "string",
nullable = false,
displayEditDialog = "y-input",
displayTable = "text",
sort = "none",
filter = true,
label = "NoLabel",
visible = true,
orderId = -1,
userCreated = false
bodyCell__minWidth: UnitNumberValue | undefined = undefined,
bodyCell__maxWidth: UnitNumberValue | undefined = undefined,
bodyCell__fontAlignHorizontal: String | undefined = undefined,
bodyCell__fontAlignVertical: String | undefined = undefined,
columnHeader__fontAlignHorizontal: String | undefined = undefined,
columnHeader__fontAlignVertical: String | undefined = undefined,
columnHeader__bgColor: ColorValue | undefined = undefined,
bodyCell__bgColor: ColorValue | undefined = undefined,
sticky = false,
columnHeader__fontSize: UnitNumberValue | undefined = undefined,
columnHeader__fontWeight: NumberValue | undefined = undefined,
bodyCell__fontSize: UnitNumberValue | undefined = undefined,
bodyCell__fontWeight: Number | undefined = undefined,
columnHeader__fontColor: ColorValue | undefined = undefined,
bodyCell__fontColor: ColorValue | undefined = undefined
);
}
| Name | Type | Description |
|---|---|---|
| field | String | Entity property name |
| type | String | Entity property type |
| nullable | Boolean | Whether null is a valid value |
| displayEditDialog | String | Control how the value gets displayed for edit |
| displayTable | String | Controls how the values get visualized in table |
| sort | String | Column sort |
| filter | Boolean | Show filter options |
| label | String | Column label |
| name | String | Uniqe column name |
| visible | Boolean | Hide column |
| sticky | Boolean | Sticky Column(always visible) |
| orderId | Number | Order position |
| userCreated | Boolean | Indicates whether the column was created by a user |
| bodyCell__minWidth | UnitNumberValue | undefined | Overrides column min width |
| bodyCell__maxWidth | UnitNumberValue | undefined | Overrides column max width |
| bodyCell__fontAlignHorizontal | String | undefined | Overrides hoizontal content alignment |
| bodyCell__fontAlignVertical | String | undefined | Overrides vertical content alignment |
| bodyCell__bgColor | ColorValue | undefined | Overrides column background color |
| bodyCell__fontSize | UnitNumberValue | undefined | Overrides column font size |
| bodyCell__fontWeight | NumberValue | undefined | Overrides column font weight |
| bodyCell__fontColor | ColorValue | undefined | Overrides column font color |
| columnHeader__fontAlignHorizontal | String | undefined | Overrides columnheader hoizontal content alignment |
| columnHeader__fontAlignVertical | String | undefined | Overrides columnheader vertical content alignment |
| columnHeader__bgColor | ColorValue | undefined | Overrides columnheader background color |
| columnHeader__fontSize | UnitNumberValue | undefined | Overrides columnheader font size |
| columnHeader__fontWeight | Number | undefined | Overrides columnheader font weight |
| columnHeader__fontColor | ColorValue | undefined | Overrides columnheader font color |
OptionListValue
Represents a single option in a selection/list.
class OptionListValue {
value: string;
label: string;
icon?: string;
tooltip?: string;
constructor();
constructor(initValue: string);
constructor(initValue: string, initLabel: string);
constructor(initValue: string, initLabel: string, initIcon: string);
constructor(initValue: string, initLabel: string, initIcon?: string, initToolTip?: string);
constructor(initValue?: string, initLabel?: string, initIcon?: string, initToolTip?: string);
}
| Name | Type | Description |
|---|---|---|
| value | String | Option value |
| label | String | Display value |
| icon (optional) | String | Icon name |
| tooltip (optional) | String | Tooltip text |
UnitNumberValue
Represents a numeric value with a unit (for example 16px or 2rem).
Value and unit can be provided separately or as a single string.
export class UnitNumberValue {
value: number;
unit: string;
constructor();
constructor(value: string);
constructor(value: number);
constructor(value: number, unit: string);
constructor(value: number | string = 0, unit = "px");
cssValue() => string;
}
| Name | Type | Description |
|---|---|---|
| value | Number | Number value |
| unit | String | Unittype |
| cssValue() | Function | Return a string used for css classes |
EntityPropertyListEntry
Represents a selected entity property for data modelling.
class EntityPropertyListEntry {
propertyName: string;
dataType: string;
propertyType: string;
navigationProperty: string;
nullable: boolean;
constructor();
constructor(
propertyName: string,
dataType: string,
propertyType: string,
navigationProperty: string
);
constructor(
propertyName: string,
dataType: string,
propertyType: string,
navigationProperty: string,
nullable: boolean
);
constructor(
propertyName?: string,
dataType?: string,
propertyType?: string,
navigationProperty?: string,
nullable?: boolean
);
isEqual(otherEntry: EntityPropertyListEntry): boolean;
}
| Name | Type | Description |
|---|---|---|
| propertyName | String | String value |
| dataType | String | Certain data type for property, e.g. Int64, Date, Number, ... |
| propertyType | String | String value, e.g. navigation, basic, ... |
| navigationProperty | String | String value representing the connected property |
| nullable | Boolean | Boolean value |
MarkerValue
Represents a position marker on a map.
class MarkerValue {
latitude: number;
longitude: number;
label?: string;
icon?: string;
tooltip?: string;
constructor(latitude = 0, longitude = 0, label = "", icon = "", tooltip = "");
}
| Name | Type | Description |
|---|---|---|
| latitude | Number | Number value |
| longitude | Number | Number value |
| label (optional) | String | String value |
| icon (optional) | String | String value |
| tooltip (optional) | String | String value |
TrackValue
Represents a media track (for example subtitles) for audio or video.
class TrackValue {
kind: string;
label: string;
language: string;
source: string;
constructor(kind = "subtitles", label = "English", language = "en", source = "");
}
| Name | Type | Description |
|---|---|---|
| kind | String | String value, e.g. subtitles |
| label | String | String value |
| language | String | String value |
| source | String | String value |
DivToPdfOptions
Options for rendering containers to PDF.
class DivToPdfOptions {
format?: PdfFormat;
marginMillimeter?: number;
dpi?: number;
orientation?: "p" | "l";
fitMode?: FitMode;
center?: boolean;
constructor(
format = "a4",
marginMillimeter = 0,
dpi = 96,
orientation?: "p" | "l",
fitMode?: FitMode,
center?: boolean
);
}
| Name | Type | Description |
|---|---|---|
| format (optional) | String | String value, e.g. 'a4', 'letter' or [width,height] in pt |
| marginMillimeter (optional) | Number | Number value |
| dpi (optional) | Number | Number value |
| orientation (optional) | String | "p" or "l" |
| fitMode (optional) | String | String value, e.g. "contain", "width", ... |
| center (optional) | Boolean | Boolean value |
ElementReference
References a yeet component.
class ElementReference {
elementId: number;
elementType: string;
constructor(elementId = -1, elementType = "y-component");
}
| Name | Type | Description |
|---|---|---|
| elementId | Number | Number value |
| elementType | String | String value |
System
Helpers for navigation, PDF export, media access, email, location, speech, user metadata and actions.
navigateTo()
navigateTo(location, external) => void
Navigates to a page inside or outside your application.
| Name | Type | Description |
|---|---|---|
| location | String | Route or URL of the target page |
| external | Boolean | true if the router should redirect to an external URL |
printToPdf()
printToPdf(targets, sourceConfigType, sourceConfigId, filename, options, returnBytesInsteadOfSaving) => string[] | undefined
Combines one or more container elements and renders them as a PDF.
| Name | Type | Description |
|---|---|---|
| targets | ElementReference[] | A list of elements to be combined as a pdf |
| sourceConfigType | String | String value |
| sourceConfigId | Number | Number value |
| filename | String | String value |
| options | DivToPdfOptions | Options to be provided to customize pdf parameters |
| returnBytesInsteadOfSaving | Boolean | Boolean value to control whether to download or to return bytes |
As a return value, you receive an array of bytes if returnBytesInsteadOfSaving is set to true.
Media
Helpers for interacting with the built-in Media Manager.
downloadFile()
downloadFile(path, fileName, downloadName) => void
Downloads a file from the Media Manager.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file is stored in the Media Manager |
| fileName | String | File name under which it is stored in the folder |
| downloadName (optional) | String | Name under which the file should be downloaded by the browser |
uploadFile()
uploadFile(path, showNotify) => void
Opens a file dialog and uploads a file to the Media Manager.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file should be stored |
| showNotify (optional) | Boolean | Shows a notification on success or failure if true |
deleteFile()
deleteFile(path, name, showNotify) => void
Deletes a file in the Media Manager.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file is stored |
| name | String | File name under which it is stored in the folder |
| showNotify (optional) | Boolean | Shows a notification on success or failure if true |
updateFile()
updateFile(path, name, value showNotify) => void
Replaces the content of an existing file in the Media Manager.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file is stored |
| value | String | New file content as a base64 string |
| name | String | File name under which it is stored in the folder |
| showNotify (optional) | Boolean | Shows a notification on success or failure if true |
loadFileData()
loadFileData(path, fileName, binary) => string | undefined
Reads the content of a file from the Media Manager.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file is stored |
| fileName | String | File name under which it is stored in the folder |
| binary (optional) | Boolean | If true, returns binary data instead of a base64 string |
As a return value, you receive a base64 string or a binary value, depending on the binary flag.
uploadFileData()
uploadFileData(path, content, fileName, mimeType, showNotify) => void
Uploads a file to the Media Manager using raw bytes.
| Name | Type | Description |
|---|---|---|
| path | String | Folder path where the file should be stored |
| content | Uint8Array | File content as Uint8Array |
| fileName | String | File name under which it should be stored in the folder |
| mimeType | String | MIME type, e.g. image/png |
| showNotify (optional) | Boolean | Shows a notification on success or failure if true |
createDirectory()
createDirectory(directoryName, showNotify) => void
Creates a new folder in the Media Manager.
| Name | Type | Description |
|---|---|---|
| directoryName | String | Name of the folder |
| showNotify (optional) | Boolean | Shows a notification on success or failure if true |
deleteDirectory()
deleteDirectory(name, showNotify) => void
Deletes a folder in the Media Manager.
| Name | Type | Description |
|---|---|---|
| name | String | Name of the folder to delete |
| showNotify | Boolean | Shows a notification on success or failure if true |
Email
Helpers fro sending emails.
sendUserMail()
sendUserMail(mailData, showNotify) => void
Sends an email using the configured mail settings.
| Name | Type | Description |
|---|---|---|
| mailData | yODataSendUserMailData | Object containing all relevant information for sending the email |
| showNotify | Boolean | Shows a notification on success or failure if true |
Location
Helpers for location-based information.
getGeoLocation()
getGeoLocation() => void
Requests the current geolocation and returns it as an object.
For this function to work, the user must allow location access in the browser.
Speech
Helpers for text-to-speech.
loadVoices()
loadVoices() => void
Loads all available system voices.
Call this function once before using any other speech function to ensure voices are available.
getVoices()
getVoices() => SpeechSynthesisVoice[]
Returns all loaded voices.
speak()
speak(text, lang) => void
Speaks the given text using the selected language.
| Name | Type | Description |
|---|---|---|
| text | String | Text to be spoken |
| lang | String | Language code, e.g. "de", "en" |
pause()
pause() => void
Pauses the current speech output.
resume()
resume() => void
Resumes the current speech output.
cancel()
cancel() => void
Cancels the current speech output.
User
Metadata for the logged-in user.
| Name | Type | Description |
|---|---|---|
| name | string | Username of the logged-in user. |
| role | string | Role of the user. |
| token | string | (Currently not supported) |
| refreshToken | string | (Currently not supported) |
Actions
Create()
create(rpcName, actionName) => yeetActionObject
If you want to execute a C16 function on the yeetCore, you can create an action object with the create() method. The action object will then be internally registered and can be queried by the action name. You can then execute the function, control the status, or query the result through the action object.
| Name | Type | Description |
|---|---|---|
| rpcName | string | C16 action name |
| actionName (optional) | string | If no actionName is provided, the action is registered under the rpcName. |
As a return value, you will receive your yeetActionObject.
Delete()
delete(actionName) => void
If you want to delete an yeetActionObject, you can unregister the yeetActionObject using the action name.
| Name | Type | Description |
|---|---|---|
| actionName | string | Registered action name |
There is no return value.
Get()
get(actionName) => yeetActionObject
Once you have registered an yeetActionObject, you can retrieve it at any time using the action name.
| Name | Type | Description |
|---|---|---|
| actionName | string | Registered action name |
As a return value, you will receive your yeetActionObject.
Clipboards
ClipboardEntityDelete()
ClipboardEntityDelete(ClipboardId) => void
Deletes an entity entry via the Clipboard.
The Clipboard deletes the record whose RecordID is stored under the Keys group as _id.
To execute this command, the Clipboard must have "use Entity" enabled and all required entity properties must be configured.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
There is no return value.
ClipboardEntityUpdate()
ClipboardEntityUpdate(ClipboardId) => void
Updates an entity entry via the Clipboard.
The Clipboard updates the record with the RecordID stored under the Keys group as \_id.
The values of the Clipboard properties are transferred to the entity properties.
For this to work, the Clipboard property names must match the entity property names.
To automatically generate Clipboard properties from an entity, enable AutoProperties for the entity properties in the Clipboard configuration.
The Clipboard must have "use Entity" enabled and all required entity properties must be specified.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
There is no return value.
ClipboardEntityRead()
ClipboardEntityRead(ClipboardId) => void
Loads an entity entry into the Clipboard.
The Clipboard reads the record whose RecordID is stored under the Keys group as _id.
The loaded data is written to the matching Clipboard properties.
Once all values are set, an update is sent to all components that are listening to this Clipboard via SourceLink.
The Clipboard must have "use Entity" enabled and all required entity properties must be specified.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
There is no return value.
ClipboardUpdate()
ClipboardUpdate(ClipboardId, value) => void
Updates multiple Clipboard properties at once using a JavaScript object. Each key corresponds to a Clipboard property name, and the value is the new property value.
{
property1: "text",
property2: 2
}
After the update, a change notification is sent to all components listening to the Clipboard via SourceLinks.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
| value | FrontEndyeetODataTypes | Javascript-Object that describes every updated Clipboardproperty |
There is no return value.
ClipboardRead()
ClipboardRead(ClipboardId) => Promise<FrontEndyeetODataTypes>
Reads all properties from a Clipboard.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
As a return value, you receive a Promise that resolves to a FrontEndyeetODataTypes object.
setEntityKeys()
setEntityKeys(ClipboardId, keyName, keyValue) => void
Sets the entity key for the Clipboard.
With the yeet database, you typically only need to set the _id property.
Future OData sources may allow multiple entity keys.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
| keyName | string | Name of the entity key property |
| keyValue | number | New value of the entity key property |
There is no return value.
getEntityKeys()
getEntityKeys(ClipboardId) => Promise<FrontEndyeetODataTypes>
Returns the current entity keys of the Clipboard (for example the _id of the active record).
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
As a return value, you receive a Promise that resolves to a FrontEndyeetODataTypes object.
propertyUpdate()
propertyUpdate(ClipboardId, propertyName, value) => void
Updates a single Clipboard property.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
| propertyName | string | Clipboard-Property-Name |
| value | string, number | Neuer Propertywert |
There is no return value.
propertyRead()
propertyRead(ClipboardId, propertyName) => void
Reads the value of a single Clipboard property.
| Name | Type | Description |
|---|---|---|
| ClipboardId | number | Unique Clipboard ID. |
| propertyName | string | Clipboard property name |
As a return value, you receive a Promise that resolves to a string or number.
Popup
Helpers for interacting with yPopup.
popupClose()
popupClose(popupId) => void
Closes a yPopup by its ID.
| Name | Type | Description |
|---|---|---|
| popupId | number | ComponentID of the yPopup generic > meta > componentId |
There is no return value.
popupOpen()
popupOpen(popupId, componentType, componentId, parentType, parentId) => void
Opens a popup and positions it relative to a specific component. You pass:
-
the popup to open and
-
the component (and its main container) that should act as the positioning reference.
| Name | Type | Description |
|---|---|---|
| popupId | number | Component ID of the yPopup generic > meta > componentId |
| componentType | string | Component type from which it was opened. |
| componentId | number | Component ID from which it was opened. |
| parentType | string | MainContainer type from which it was opened. |
| parentid | number | MainContainer id from which it was opened. |
There is no return value.
OData
odataEntityCreate()
odataEntityCreate(entityName, entityValue, baseUrl?) => Promise<yODataResponse<unknown>>
You can use odataEntityCreate to create a new entity entry using JavaScript.
| Name | Type | Description |
|---|---|---|
| entityName | string | Name of the entity in the database |
| entityValue | FrontEndyeetODataTypes | Object containing data for the entity properties |
| baseUrl (optional) | string | URL to another yeet database (not yet supported) |
As a return value, you will receive a Promise which returns the newly created entity entry. Since the ID is automatically assigned, you can directly retrieve the RecordID of your new entry.
odataEntityDelete()
odataEntityDelete(entityName: string, entityKeyPropertyValues: FrontEndyeetODataTypes, baseUrl?: string | undefined) => Promise<yODataResponse<unknown>>
To delete an entity entry, you need to provide an object that contains all the entity keys and their corresponding values. In the yeet database, there is always only one entity key (_id), which is the record related id.
| Name | Type | Description |
|---|---|---|
| entityName | string | Name of the entity in the database |
| entityKeyPropertyValues | FrontEndyeetODataTypes | Object containing all the entity key values of the entry to be deleted |
| baseUrl (optional) | string | URL to another yeet database (not yet supported) |
As a return value, you receive a promise that returns an empty string upon completion.
odataEntityRead()
odataEntityRead(entityName, query, entityKeyValues, baseUrl?) => Promise<yODataResponse<unknown>>
To read an entity entry, you can pass a yODataQuery object to retrieve a list of entity entries, or you can select a specific entry using entityKeyValues. In the yeet database, there is always only one entity key(_id), which is the record related id.
| Name | Type | Description |
|---|---|---|
| entityName | string | Name of the entity in the database |
| query | yODataQuery | undefined | Object with various options to load a list of entities |
| entityKeyValues | FrontEndyeetODataTypes | Object containing all entity key values of the entity entry to be read |
| baseUrl (optional) | string | URL to another yeet database (not yet supported) |
As a return value, you will receive a promise that is filled with an array containing all queried entity entries.
odataEntityUpdate()
odataEntityUpdate(entityName, entityValue, entityKeyPropertyValues, baseUrl?) => Promise<>
To update an entity entry, you can provide an object to specify the entries that are supposed to be updated. You also need to provide the entityKeyPropertyValues object to determine which entity entry should be modified. In the yeet database, there is always only one entity key (_id), which is the record related ID.
| Name | Type | Description |
|---|---|---|
| entityName | string | Name of the entity in the database |
| entityValue | FrontEndyeetODataTypes | Object containing new values for the entity properties |
| entityKeyPropertyValues | FrontEndyeetODataTypes | Object containing all the entity key values of the entity entry to be modified |
| baseUrl (optional) | string | URL to another yeet database (not yet supported) |
The return value is a promise without a return value.
odataMetaData()
odataMetaData(baseUrl?) => Promise<yODataMetadata>
The metadata of the database can be retrieved using odataMetaData.
| Name | Type | Description |
|---|---|---|
| baseUrl (optional) | string | URL to another yeet database (not yet supported) |
As a return value, you will receive a promise that returns a MetadataObject. You can find all entities, enums, and actions here.
Objecttypes
yODataQuery
Optional query properties.
let queryOptions = {
$filter?: string;
$select?: string[];
$skip?: number;
$top?: number;
}
| Name | Type | Description |
|---|---|---|
| $filter (optional) | String | Odata filter string |
| $select (optional) | String[] | Which entity properties should be loaded |
| $skip (optional) | Number | How many entries to skip |
| $top (optional) | Number | How many entity records to load |
yODataSendUserMailData
Query properties to provide for sending an email via yeet.
let queryOptions = {
userName: string;
path: string;
template: string;
attachementInfos: string;
placeholderValues: string;
recipientAddress: string;
recipientName: string;
subject: string;
}
// for example
{
path: "tutorialFolder",
template: "myTemplate.html",
placeholderValues: "{'yeet:Salutation': 'Greetings', 'yeet:FirstName': 'Ash', 'yeet:LastName': 'Ketchum', 'yeet:RegistrationUrl': 'www.google.com', 'yeet:AdminName': 'Max Mustermann'}",
attachmentInfos: "[{'FileName': 'mh2.png', 'Path': 'tutorialFolder', 'Content': ''}]",
recipientAddress: "ash.ketchum@gmail.com",
recipientName: "Ask Ketchum",
subject: "Complete your registration!",
userName: "testUser"
}
| Name | Type | Description |
|---|---|---|
| userName | String | User defined in your appsettings.json |
| path | String | The path where to find the html template to use for the mail |
| template | String | The name of the actual template file |
| attachementInfos | String | An array of objects, each representing an individual attachment |
| placeholderValues | String | A stringified object of key value pairs for placeholders |
| recipientAddress | String | String value |
| recipientName | String | String value |
| subject | String | String value |
PropertyValueTypes
type PropertyValueTypes =
| string
| number
| boolean
| UnitNumberValue
| ColorValue
| ValidatorListValue[]
| OptionListValue[]
| ColumnValue[];
FrontEndyeetODataTypes
interface FrontEndyeetODataTypes {
[key: string]: FrontEndyeetODataType;
}
FrontEndyeetODataType
type Front FrontEndyeetODataType =
string | number | boolean | null
yeetRuntimeObject
This object represent a component config.
class yeetRuntimeObject {
get(category, group, property) => Propertytypes;
set(category, group, property) => void;
property(category, group, property) => yeetRuntimeProperty;
reset(category, group, property) => void;
}
Get()
get(category, group, property) => Propertytype;
| Name | Type | Description |
|---|---|---|
| category | string | Propertycategory |
| group | string | Propertygroup |
| property | string | Propertyname |
As a return value, you will receive the property value.
Set()
set(category, group, property, value) => void;
| Name | Type | Description |
|---|---|---|
| category | string | Propertycategory |
| group | string | Propertygroup |
| property | string | Propertyname |
| value | PropertyValuetypes | New property value |
There is no return value.
Property()
Creates a yeetRuntimeProperty. With this, you can directly set the property without having to specify the property path.
property(category, group, property) => yeetRuntimeProperty;
| Name | Type | Description |
|---|---|---|
| category | string | Property category |
| group | string | Property group |
| property | string | Property name |
As a return value, you will receive the yeetRuntimeProperty.
Reset()
Indicates that the property should be set by the theme again.
Not all properties can be set by a theme.
reset(category, group, property) => void;
| Name | Type | Description |
|---|---|---|
| category | string | Property category |
| group | string | Property group |
| property | string | Property name |
There is no return value.
yeetRuntimeProperty
This object represent a component property.
class yeetRuntimeObjectProperty {
get()=>PropertyValueTypes;
set(value: PropertyValueTypes)=>void;
reset()=>void;
}
Get()
Gets the value of the property.
get() => PropertyValueTypes;
As a** return value**, you receive a PropertyValueType object.
Set()
Sets the value of the property.
set(value) => PropertyValueTypes;
| Name | Type | Description |
|---|---|---|
| value | PropertyValueTypes | neues Value für die Property |
There is no return value.
Reset()
Indicates that the property should be set again by the theme.
Not all properties can be set by a theme.
reset() => void;
There is no return value.